Show:

Places user location Class

Defined in: platform/plugins/Places/handlers/Places/user/location/tool.php:7
Module: Places-tools

Inplace text editor tool to edit the content or attribute of a stream

Constructor

Places user location

(
  • [$options]
  • [$options.updateButton="Update
)

Defined in platform/plugins/Places/handlers/Places/user/location/tool.php:7

Parameters:

  • [$options] Array optional

    used to pass options

    • [meters] Array optional

      array of { meters: title } pairs, by default is generated from Places/nearby/meters config

    • [defaultMeters] Array optional

      override the key in the meters array to select by default. Defaults to "Places/nearby/defaultMeters" config

    • [units] String optional

      second parameter to pass to Places::distanceLabel()

    • [map] Array optional

      options for the map

      • [delay=300] Integer optional
        how many milliseconds to delay showing the map, e.g. because the container is animating
      • [prompt="img/map.png"] String optional
        The src of the map graphical prompt when no location has been selected yet
    • [onUpdate] String optional

      name an event handler for when the location is updated

    • [onUnset] String optional

      name an event handler for when the location is unset

  • [$options.updateButton="Update String

    my location"] the title of the update button

Item Index